More doc updates
authorparkrrrr <parkrrrr>
Thu, 18 May 2006 15:52:31 +0000 (15:52 +0000)
committerparkrrrr <parkrrrr>
Thu, 18 May 2006 15:52:31 +0000 (15:52 +0000)
14 files changed:
xmldoc/chapters/_chapters.xml
xmldoc/chapters/allchapters.xml
xmldoc/chapters/datums.xml [new file with mode: 0644]
xmldoc/formats/garmin_txt.xml
xmldoc/formats/mapsource.xml
xmldoc/formats/options/garmin_txt-date.xml
xmldoc/formats/options/garmin_txt-datum.xml
xmldoc/formats/options/garmin_txt-dist.xml
xmldoc/formats/options/garmin_txt-prec.xml
xmldoc/formats/options/garmin_txt-temp.xml
xmldoc/formats/options/garmin_txt-time.xml
xmldoc/formats/options/garmin_txt-utc.xml
xmldoc/formats/options/ignrando-index.xml
xmldoc/formats/options/stmwpp-index.xml

index 9b75d3d6338aff4024c2453e5e367142422042a4..6ce0611e41b75d2c42d88d81999a4c5d44facfb3 100644 (file)
@@ -4,3 +4,4 @@
 <!ENTITY chap_use SYSTEM "use.xml">
 <!ENTITY chap_formats SYSTEM "formats.xml">
 <!ENTITY chap_filters SYSTEM "filters.xml">
+<!ENTITY app_datums  SYSTEM "datums.xml">
index 79e457686b84062972ea2ae3a1c33f098f7dfcfa..bffbe70e8839d66c84f3862ced9f3559b9a199d4 100644 (file)
@@ -3,3 +3,4 @@
 &chap_use;
 &chap_formats;
 &chap_filters;
+&app_datums;
diff --git a/xmldoc/chapters/datums.xml b/xmldoc/chapters/datums.xml
new file mode 100644 (file)
index 0000000..3bc4744
--- /dev/null
@@ -0,0 +1,138 @@
+<appendix id="Datums">
+<title>Supported Datums</title>
+<para>
+Some formats in GPSBabel support multiple datums.  For example, the 
+<option>datum</option> option to the 
+<link linkend="fmt_garmin_txt">garmin_txt</link> format allows you to specify
+a datum for the output file.  
+</para>
+<para>
+The following is a list of the datums supported by GPSBabel.
+</para>
+
+<simplelist columns="5">
+<member>Adindan</member>
+<member>AFG</member>
+<member>Ain-El-Abd</member>
+<member>Alaska-NAD27</member>
+<member>Alaska-Canada</member>
+<member>Anna-1-Astro</member>
+<member>ARC 1950 Mean</member>
+<member>ARC 1960 Mean</member>
+<member>Asc Island 58</member>
+<member>Astro B4</member>
+<member>Astro Beacon E</member>
+<member>Astro pos 71/4</member>
+<member>Astro stn 52</member>
+<member>Australia Geo 1984</member>
+<member>Bahamas NAD27</member>
+<member>Bellevue IGN</member>
+<member>Bermuda 1957</member>
+<member>Bukit Rimpah</member>
+<member>Camp_Area_Astro</member>
+<member>Campo_Inchauspe</member>
+<member>Canada_Mean(NAD27)</member>
+<member>Canal_Zone_(NAD27)</member>
+<member>Canton_Island_1966</member>
+<member>Cape</member>
+<member>Cape_Canaveral_mean</member>
+<member>Carribean NAD27</member>
+<member>Carthage</member>
+<member>Cent America NAD27</member>
+<member>Chatham 1971</member>
+<member>Chua Astro</member>
+<member>Corrego Alegre</member>
+<member>Cuba NAD27</member>
+<member>Cyprus</member>
+<member>Djakarta(Batavia)</member>
+<member>DOS 1968</member>
+<member>Easter lsland 1967</member>
+<member>Egypt</member>
+<member>European 1950</member>
+<member>European 1950 mean</member>
+<member>European 1979 mean</member>
+<member>Finnish Nautical</member>
+<member>Gandajika Base</member>
+<member>Geodetic Datum 49</member>
+<member>Ghana</member>
+<member>Greenland NAD27</member>
+<member>Guam 1963</member>
+<member>Gunung Segara</member>
+<member>Gunung Serindung 1962</member>
+<member>GUX1 Astro</member>
+<member>Herat North</member>
+<member>Hjorsey 1955</member>
+<member>Hong Kong 1963</member>
+<member>Hu-Tzu-Shan</member>
+<member>Indian</member>
+<member>Iran</member>
+<member>Ireland 1965</member>
+<member>ISTS 073 Astro 69</member>
+<member>Johnston Island 61</member>
+<member>Kandawala</member>
+<member>Kerguelen Island</member>
+<member>Kertau 48</member>
+<member>L.C. 5 Astro</member>
+<member>La Reunion</member>
+<member>Liberia 1964</member>
+<member>Luzon</member>
+<member>Mahe 1971</member>
+<member>Marco Astro</member>
+<member>Masirah Is. Nahrwan</member>
+<member>Massawa</member>
+<member>Merchich</member>
+<member>Mexico NAD27</member>
+<member>Midway Astro 61</member>
+<member>Mindanao</member>
+<member>Minna</member>
+<member>Montjong Lowe</member>
+<member>Nahrwan</member>
+<member>Naparima BWI</member>
+<member>North America 83</member>
+<member>N. America 1927 mean</member>
+<member>Observatorio 1966</member>
+<member>Old Egyptian</member>
+<member>Old Hawaiian_mean</member>
+<member>Old Hawaiian Kauai</member>
+<member>Old Hawaiian Maui</member>
+<member>Old Hawaiian Oahu</member>
+<member>Oman</member>
+<member>OSGB36</member>
+<member>Pico De Las Nieves</member>
+<member>Pitcairn Astro 67</member>
+<member>S. Am. 1956 mean(P)</member>
+<member>S. Chilean 1963 (P)</member>
+<member>Puerto Rico</member>
+<member>Pulkovo 1942</member>
+<member>Qornoq</member>
+<member>Quatar National</member>
+<member>Rome 1940</member>
+<member>S-42(Pulkovo1942)</member>
+<member>S.E.Asia_(Indian)</member>
+<member>SAD-69/Brazil</member>
+<member>Santa Braz</member>
+<member>Santo (DOS)</member>
+<member>Sapper Hill 43</member>
+<member>Schwarzeck</member>
+<member>Sicily</member>
+<member>Sierra Leone 1960</member>
+<member>S. Am. 1969 mean</member>
+<member>South Asia</member>
+<member>Southeast Base</member>
+<member>Southwest Base</member>
+<member>Tananarive Obs 25</member>
+<member>Thai/Viet (Indian)</member>
+<member>Timbalai 1948</member>
+<member>Tokyo mean</member>
+<member>Tristan Astro 1968</member>
+<member>United Arab Emirates</member>
+<member>Viti Levu 1916</member>
+<member>Wake Eniwetok 60</member>
+<member>WGS 72</member>
+<member>WGS 84</member>
+<member>Yacare</member>
+<member>Zanderij</member>
+<member>Sweden</member>
+</simplelist>
+</appendix>
+
index 6ff12da655f18913f79005f6a4c150934d714e10..868a97540851cb9144d52d1af9c3edeb65cee146 100644 (file)
@@ -1,36 +1,23 @@
-
-      
-      
-      <para>
-  garmin_txt is a format that contains nearly all information as in the MapSource main format, GDB.
-garmin_txt has some computed values like distances between routepoints and trackpoints, speed, and course (heading) in addition to the standard data fields.
-      </para>
-      <para>
+<para>
+This is a textual format that contains nearly all of the information 
+contained in the MapSource main format, <link linkend="fmt_gdb">GDB</link>.
+This format also contains some computed values such as distances between 
+routepoints and trackpoints, speed, and course (heading).
+</para>
+<para>
 The main goal of garmin_txt is to make aviation data more available. Because 
 MapSource supports only the export, GPSBabel gives you the possibility to 
 bring aviation data into MapSource.
-      </para>
-      <para>
+</para>
+<para>
 During the export with MapSource, some fields are written using local settings
 of MapSource and Windows. These include grid format, gps datum, distance and
 temperature units, and the representation of date and time fields. GPSBabel 
 tries to read all items automatically. Problems with date and time format can 
-be solved with the options 'date' and 'time'.
-      </para>
-      <para>Options:</para>
-      <para><option>date</option> -  input/output date format (Windows-like. For example  "YYYY/MM/DD")</para>
-      <para><option>datum</option> - write coodinates using this (GPSBabel known!) datum </para>
-      <para><option>dist</option> -  output unit for distance values, M (=metric, m/km/kph) or S (=statue, ft/mi/mph)</para>
-      <para><option>prec</option> -  write coordinates with precision # (# numbers behind dot)</para>
-      <para><option>temp</option> -  output unit for temperature values, C (=celsius) or F (=fahrenheit)</para>
-      <para><option>time</option> -  input/output time format (Windows-like For example, "hh:mm:ss xx")</para>
-      <para><option>utc</option> -   write timestamps x hours relative to UTC</para>
-      <example id="all_garmin_txt_options">
-        <title>Command showing garmin_txt output with all options</title>
-       <screen format="linespecific">gpsbabel -i garmin_txt,date="MM/DD/YYYY",time="hh:mm:ss xx" \
-   -f in.txt \
-   -o garmin_txt,date="DD.MM.YYYY",datum="WGS 72",dist=m,prec=6,temp=c,time="HH:mm:ss",utc=+2 \
-   -F out.txt
-        </screen>
-      </example>
+be solved with the 'date' and 'time' options.
+</para>
+<example id="all_garmin_txt_options">
+  <title>Command showing garmin_txt output with all options</title>
+  <screen format="linespecific">gpsbabel -i garmin_txt,date="MM/DD/YYYY",time="hh:mm:ss xx" -f in.txt -o garmin_txt,date="DD.MM.YYYY",datum="WGS 72",dist=m,prec=6,temp=c,time="HH:mm:ss",utc=+2 -F out.txt</screen>
+</example>
     
index 31f4319ab187ce22e83b593e9ce705ef1e5fe273..7460e008b5ff7a54c4e7ac9c6ef60ac10bc00609 100644 (file)
@@ -12,13 +12,14 @@ Altitude is supported, but proximity and depth are not.
 Naming files *.mps will allow file-&gt;open in Mapsource to find the files 
 more easily.  
 </para>
+<para>
 Versions 3, 4, and 5 of the Mapsource data format are handled automatically 
 on input.  By default the output is version 5.  (Until 3/2004, it was
 version 3, but since Mapsource updates are free, the convenience of
 having modern icon sets outweighs the backward compatibility concern.
 Users of other versions can either upgrade or specify the switches to
 get output in a compatible format.)  Waypoints, routes, and tracklogs are 
-all handled, but maps sets are ignored.
+all handled, but map sets are ignored.
 </para>
 <para> 
 Information on the Garmin Mapsource format was provided by Ian Cowley and 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..fbaae4b8f0ee7ec4c7eda7946fa9f855396219c5 100644 (file)
@@ -1 +1,4 @@
-
+<para>
+This options specifies the input and output format for the date.  The format 
+is written similarly to those in Windows.  An example format is "YYYY/MM/DD".
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f31c58d79e9c8b70ade1bf7bf638e6b4d02e81a7 100644 (file)
@@ -1 +1,4 @@
-
+<para>
+This option specifies the datum to be used on output.  Valid values for this 
+option are listed in <link linkend="Datums">the appendix</link>.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f3a48251e8c4e17080c32c0a0ad1811489235c4d 100644 (file)
@@ -1 +1,5 @@
-
+<para>
+This option specifies the unit to be used when outputting distance
+values.  Valid values are M for metric (m/km/kph) or S for statute
+(ft/mi/mph).
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..962de067f2393c6549a2169f8f867e478cb3e9c1 100644 (file)
@@ -1 +1,5 @@
-
+<para>
+This option specifies the precision to be used when writing coordinate values.
+Precision is the number of digits after the decimal point.  The default
+precision is 3.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f1de8e27aaeb504ea3038ab85192bb0d52f5d2f7 100644 (file)
@@ -1 +1,4 @@
-
+<para>
+This option specifies the unit to be used when writing temperature values.
+Valid values are C for Celsius or F for Fahrenheit.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..714c7f3ed65dbb7a88c0a360ad7a1c80a5680a8d 100644 (file)
@@ -1 +1,4 @@
-
+<para>
+This options specifies the input and output format for the time.  The format 
+is written similarly to those in Windows.  An example format is "hh:mm:ss xx".
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..4c2964e0e6d8eb49f330fd3e8f4b9bfe8c6f97fb 100644 (file)
@@ -1 +1,5 @@
-
+<para>
+This option specifies the local time zone to use when writing times.  It
+is specified as an offset from Universal Coordinated Time (UTC) in hours.  
+Valid values are from -23 to +23.
+</para>  
index 714a9c22f7f8be7b5663e8ca395a84c99c6a854b..42c8f4e6fcb3bf6fbff1f5922ac8ef8e9754c6a3 100644 (file)
@@ -1,8 +1,8 @@
 <para>
-Because the format supports only one track, this option can be used 
+Because the format supports only one track, this option may be used 
 on output to select a single track from a collection of 
 tracks read from a more expressive format.  If you have, say, a 
-<link linkend="fmt_gpx">gpx</link> file that contains two tracks, you can
+<link linkend="fmt_gpx">gpx</link> file that contains two tracks, you may
 use this option to write them one at a time to individual files.
 </para>
 <screen format="linespecific">gpsbabel -i gpx -f tracks.gpx -o ignrando,index=1 -F track1.txt -o ignrando,index=2 -F track2.txt</screen>
index 3defd318e29633e009a9e7678207d73415a56c68..6187a66a8d663255773a0b54a878dbd145eb0e9d 100644 (file)
@@ -1,8 +1,8 @@
 <para>
-Because the format supports only one route or track, this option can be used 
+Because the format supports only one route or track, this option may be used 
 on output to select a single route or track from a collection of routes and
 tracks read from a more expressive format.  If you have, say, a 
-<link linkend="fmt_gpx">gpx</link> file that contains three routes, you can
+<link linkend="fmt_gpx">gpx</link> file that contains three routes, you may
 use this option to write them one at a time to individual files.
 </para>
 <screen format="linespecific">gpsbabel -i gpx -f routes.gpx -o stmwpp,index=1 -F route1.txt -o stmwpp,index=2 -F route2.txt -o stmwpp,index=3 -F route3.txt</screen>